<?php
	/**
	 * @package AmpleHarvest
	 */
	require_once 'TableHeader.php';

	/**
	 * @brief This class Describes the Query_History Table in the AmpleHarvest Database
	 *
	 * - Revision History
	 *  - 0.1
	 * 	 - <b>Date</b>: 24 MAR 2011
	 * 	 - <b>Author</b>: Randy Blancett
	 * 	  - Initial Version
	 *
	 * @author Randy Blancett
	 * @version 0.1
	 * @ingroup code classes table
	 */
	class cTABLE_Query_History extends cTable
	{
		/**
		 * @{
		 * @name Columns
		 */
		public $m_int_COL_ID = null;
		public $m_int_COL_User_ID = null;
		public $m_int_COL_Date = null;
		public $m_int_COL_Query = null;
		public $m_int_COL_Source = null;
		/**
		 * @}
		 */

		/**
		 * This constructor sets all the required column data
		 */
		public function __construct()
		{
			$this->m_str_TableName = "query_history";
			$this->set_Engine(self::C_STR_ENGINE_INNODB);

			//Create Column Objects
			$obj_COL_ID = new cColVarChar("id");
			$obj_COL_ID->set_Length(36);
			$obj_COL_ID->set_Index(abs_Column::c_int_INDEX_PRIMARY);
			$obj_COL_ID->set_Comment("This column holds the ID of the query.");
			$obj_COL_ID->set_Editable(false);
			$obj_COL_ID->set_Label("ID");

			$obj_COL_Source_ID = new cColVarChar("source_id");
			$obj_COL_Source_ID->set_Length(36);
			$obj_COL_Source_ID->set_Comment("This column holds the ID of the querys source.");
			$obj_COL_Source_ID->set_Editable(false);
			$obj_COL_Source_ID->set_Label("Source");

			$obj_COL_User_ID = new cColVarChar("user_id");
			$obj_COL_User_ID->set_Length(36);
			$obj_COL_User_ID->set_Comment("This column holds the ID of the User.");
			$obj_COL_User_ID->set_Editable(false);
			$obj_COL_User_ID->set_Label("User");

			$obj_COL_Date = new cColDateTime("date");
			$obj_COL_Date->set_Comment("This column holds the Date that the column was last touched.");
			$obj_COL_Date->set_Label("Time Stamp");

			$obj_COL_QueryString = new cColText("query");
			$obj_COL_QueryString->set_Comment("This column holds the Query the user executed.");
			$obj_COL_QueryString->set_Label("Query");

			//Set up connection
			$this->m_obj_Connection = new cConnection("AmpleHarvest", "admin");

			//Activate all Debug options
			$this->m_obj_Connection->set_DebugLevel(cLog_Connection_Debug::c_int_LEVEL_BASIC);
			$this->m_obj_Connection->set_LogLevel(cLog_Connection::c_int_LEVEL_BASIC);
			$this->m_obj_Connection->activate_Logging();
			$this->m_obj_Connection->activate_LogDebug();
			//$this->m_obj_Connection->activate_ScreenDebug();

			$this->m_int_COL_ID = $this->add_Column($obj_COL_ID);
			$this->m_int_COL_Date = $this->add_Column($obj_COL_Date);
			$this->m_int_COL_Query = $this->add_Column($obj_COL_QueryString);
			$this->m_int_COL_Source = $this->add_Column($obj_COL_Source_ID);
			$this->m_int_COL_User_ID = $this->add_Column($obj_COL_User_ID);
		}

		/**
		 * Returns if the id is a valid and existing ID
		 * @param string $str_User_ID ID of the Page to check (GUID)
		 * @return boolean true if valid false if not
		 */
		public function validate_ID($str_ID)
		{
			// ensure that there is an ID passed and that it is a valid GUID
			if (!empty($str_ID) && preg_match(self::c_REG_GUID_VALID, $str_ID))
			{
				$this->clear_Query();
				$this->add_ColumnQuery($this->m_int_COL_ID, $str_ID);
				if ($this->do_Search() > 0)
				{
					return true;
				}
			}
			return false;
		}

		/**
		 * Saves Information to the Database
		 */
		public function save_Data2DB()
		{
			if ($this->validate_ID($this->get_id()))
			{
				return $this->update_Data2DB();
			}
			else
			{
				return $this->insert_Data2DB();
			}

			return false;
		}
		/**
		 * This function is used to update data that is already in the database
		 */
		public function update_Data2DB()
		{
			$this->clear_Update();
			$this->add_ColumnQuery($this->m_int_COL_ID, $this->get_id());

			return parent::update_Data2DB();
		}
		/**
		 * This function is used to insert Data into the database
		 */
		public function insert_Data2DB()
		{
			$this->set_id($this->create_GUID());
			$this->set_date(date_format(new datetime(), "Y-m-d H:i:s"));
			return parent::insert_Data2DB();
		}
	}
?>
